<!--
  ~ Copyright (C) 2010 Brockmann Consult GmbH (info@brockmann-consult.de)
  ~
  ~ This program is free software; you can redistribute it and/or modify it
  ~ under the terms of the GNU General Public License as published by the Free
  ~ Software Foundation; either version 3 of the License, or (at your option)
  ~ any later version.
  ~ This program is distributed in the hope that it will be useful, but WITHOUT
  ~ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  ~ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  ~ more details.
  ~
  ~ You should have received a copy of the GNU General Public License along
  ~ with this program; if not, see http://www.gnu.org/licenses/
  -->
<!-- HELP-TODO: text marked as "Explanatory text" shall be filled with content -->
<!-- HELP-TODO: documentation for "Remote File Repositories" is missing-->

<html>
<head>
    <title>Sentinel Toolbox Help - The Options Dialog</title>
    <link rel="stylesheet" href="../style.css">
</head>

<body>
<table class="header">
    <tr class="header">
        <td class="header">&nbsp; The Options Dialog</td>

        <td class="header" align="right"><a href="../general/overview/SnapOverview.html"><img
                src="../images/snap_header.jpg"
                border="0"></a></td>
    </tr>
</table>
<p> The Options dialog window contains several categories of settings you are able to change.
    In the following sections screen shots are shown where the settings for the user interface behavior can be edited.
    Depending on the number of Toolboxes installed in SNAP, the header area might contain different items.
</p>
<img src="images/OptionsDialog-FooterArea.png" alt="Options Dialog - Footer Area">
<br>The buttons "Export" and "Import" in the footer area of the dialog window can be used to save or load all settings
at once.


<h3>General Settings</h3>
<h4><a name="uibehavior">UI Behaviour</a></h4>
<p>This preferences page contains general user interface behavior and memory
    management settings.</p>
<img src="images/OptionsDialog-General-1-UIBehaviour.png" alt="UI Behaviour Dialog">
<ul>
    <li><b>Show navigation window when image views are opened</b><br>
        If an image view is opened the <a href="NavigationWindow.html">Navigation Window</a>
        will also be opened.
    </li>
    <li><b>Open image view for new (virtual) bands</b><br>
        Currently, this option only affects the <a href="BandMaths.html">Band
            Maths</a> tool. If this option is selected, a new image view is automatically
        created and opened for any new bands created in the band maths tool.
    </li>
    <li><b>Show only pixel values of displayed bands</b><br>
        If selected, the pixel info view will only show pixel values of bands
        which are currently displayed in an image view. If this option is not selected,
        the Sentinel Toolbox displays <b>all</b> bands contained in a product.
        For those bands which are currently not displayed, the Sentinel Toolbox reads the sample values directly
        from the product file. Depending on your computer's I/O performance and the
        location of the product file (e.g. CD-ROM, harddrive, network) this can have
        an impact on the runtime performance.
    </li>
    <li><b>Maximum recent file list</b><br>
        Specify the number of recent files that appear in the <a href="FileMenu.html">File Menu</a> under "Reopen
        Product".
    </li>
    <li><b>Show suppressed message dialogs again</b> <br>
        Some dialogs of the Sentinel Toolbox can be disabled by checking the option &quot;Don't show
        this message again&quot;. You can select this option to enable all message and tip dialog boxes again.
    </li>
</ul>


<h4><a name="geolocation">Geo-Location</a></h4>
<p>This preferences page enables settings related to the geo-location of pixels, pins, etc. </p>
<img src="images/OptionsDialog-General-2-GeoLocation.png" alt="Geo-Location">

<p><br>
    The Sentinel Toolbox uses an image coordinate system whose origin (x=0, y=0) is the upper left corner of the
    upper left pixel. Image X-coordinates increase to the right, Y-values increase downwards.
    The center of the pixel in the origin is then located at (x=0.5, y=0.5).
</p>
<ul>
    <li><b>Snap pins to exact geo-location after import, transfer to another product, or geo-coding change</b><br>
        Enables pins to be displayed at exact location on the image.
    </li>
    <li><b>Use sub-pixel fraction accuracy for pixel-based geo-coding</b><br>
        When geo-coding is pixel-based, a sub-pixel fraction accuracy shall be used (see also "Show pixel coordinates with fractional part" below).
    </li>
    <li><b>Use high precision approximations for inverse tie point geo-coding</b><br>
        When geo-coding is tie-point based, high precision inverse approximations are used. Enabling this option slows
        down the performance
        but increases the accuracy a bit further.
    </li>
    <li><b>Show geographical coordinates in decimal degrees</b><br>
        Use decimal degree values instead of minutes and seconds.
    </li>
    <li><b>Show pixel coordinates with fractional part</b><br>
        Don't display integer coordinates.
    </li>
    <li><b>Show pixel coordinates starting at (1,1)</b><br>
        In opposite to the default setting where the pixel coordinates start at (0,0), let them count from (1,1).
    </li>
</ul>


<h4><a name="imageview">Image View</a></h4>
<p>This preferences page enables settings related to the geo-location of pixels, pins, etc. </p>
<img src="images/OptionsDialog-General-3-ImageView.png" alt="Image View">
<ul>
    <li><b>Show a navigation control widget in image views</b><br>
        If this option is selected, the Sentinel Toolbox shows a navigation widget in image views
        for moving and rotating images within the viewport: <br><br>
        <img src="images/NavigationControlWidget.png" alt="Navigation Control Widget">
    </li>
    <li><b>Show scroll bars in image views</b><br>
        If this option is selected, image views are shown with horizontal and
        vertical scroll bars.
    </li>
    <li><b>Invert mouse wheel scrolling (zoom in/zoom out)</b><br>
        For convenience, zoom in or out like e.g. in Google Earth.
    </li>
</ul>

<h4><a name="rgbprofiles">RGB Profiles</a></h4>
<img src="images/OptionsDialog-General-4-RGB-ImageProfiles.png" alt="RGB-Image Profiles">
<p>This preference page is used to edit the RGB profiles used for RGB image creation
    from various product types. An RGB-Profile defines the band maths expressions
    to be used for the red, green and blue components of an RGB image.
    For detailed information about RGB-Profiles please refer to the chapter
    <a href="RGBImageProfile.html">RGB-Image Profile</a> located at <i>Sentinel Toolbox Application/Tools/Imaging
        Tools</i>
</p>
<B>Profile</b> Lets you Select on of the actual stored RGB-Profiles to use for creation of the new image view.
<ul>
    <li>Use the <img src="images/icons/Open24.gif" alt="Open" border="0"> to open a stored
        <a href="RGBImageProfile.html#profileFile">RGB-Profile file</a>.
    </li>
    <li>Use the <img src="images/icons/Save24.gif" alt="Save" border="0"> to save the currently displayed RGB-Profile.
    </li>
    <li>Use the <img src="images/icons/Remove24.gif" alt="Save" border="0"> to delete the currently displayed
        RGB-Profile.
    </li>
</ul>
<b>RGB Channels</b>
<ul>
    <li><b>Red</b> - Defines the mathematical expression for the red channel.<br></li>
    <li><b>Green</b> - Defines the mathematical expression for the green channel.<br></li>
    <li><b>Blue</b> - Defines the mathematical expression for the blue channel.<br></li>
</ul>

<p>Use the <img src="images/icons/NextDialogButton.gif" alt="Opens the Band Maths Expression Editor" border="0"> to
    to edit the expression for the specific channel by using the <a href="ExpressionEditor.html">Maths Expression
        Editor</a>.
</p>


<p class="inote"><b>Note: </b>
    The expressions are not validated by the Sentinel Toolbox, keep care of using the correct syntax.<br>
    Please refer to the <a href="ExpressionEditor.html">Maths Expression Editor</a>
    documentation for the syntax and capablities of expressions. <br>
</p>

<h4><a name="writeoptions">Write Options</a></h4>
<img src="images/OptionsDialog-General-5-WriteOptions.png" alt="Write Options">
<p>This preference page is used to edit the writing behaviour of SNAP.</p>

<p>The first four entries are only relevant when products are saved in
    <a href="../general/overview/BeamDimapFormat.html">BEAM-DIMAP format</a>.</p>
<ul>
    <li><b>Save product header (MPH, SPH)</b><br>
        This options allows you to include/exclude the main product header (MPH) and
        specific product header (SPH) of ENVISAT products in/from the file being saved.
        If this option is selected, the Sentinel Toolbox stores the MPH and SPH as meta-data in the
        BEAM-DIMAP (XML) header.<br>
        It is recommended to always include this meta data.
    </li>
    <li><b>Save product history (History)</b><br>
        This option switches the saving of the processing history of the product on
        or off. It is recommended to always include this meta data to be able to track
        the processing stages and the original product.
    </li>
    <li><b>Save product annotation data sets (ADS)</b><br>
        This options allows you to include/exclude all annotation data sets (ADS) of
        ENVISAT products in/from the file being saved. If this option is selected,
        The Sentinel Toolbox stores ADS as meta-data in the BEAM-DIMAP (XML) header.<br>
        For ENVISAT products, location and annotation data sets (provided at tie-points)
        need not to be stored as meta data, since the Sentinel Toolbox automatically converts them
        into <i>tie point grids</i>, which are separately saved.
    </li>
    <li><b>Use incremental Save</b><br>
        If this option is selected (recommended), the Sentinel Toolbox will only save the modifications
        applied to a product, such as band modified or created with band maths
        tool or the removal of bands.
    </li>
    <li><b>Enable DIMAP write cache</b><br>
        If this option is selected (recommended), all data written to DIMAP file format will be cached before
        accessing the storage medium. This allows for a disk access schema suited for the dataformat and thus
        in most cases a higher data throughput.
    </li>
</ul>
<p>The last element generally concerns the writing process and thus also all writeable formats.</p>
<ul>
    <li><b>Write raster data concurrently</b><br>
        If this option is selected (recommended), the write operation uses the processor cores in parallel
        to write raster data. This can dramatically speed up the write process. However, it can also cause
        problems if the writer is not implemented thread save.<br>
        If the data cannot be written in parallel, please disable this option.
    </li>
</ul>

<h4><a name="newmasks">New Masks</a></h4>
<img src="images/OptionsDialog-General-6-NewMasks.png" alt="New Masks">
<p>This preference page is used to edit the default mask overlay colour and its transparency.</p>

<ul>
    <li><b>Default mask overlay colour</b> - Sets the default colour for newly created masks. Select a colour from a
        pre-defined list or customize it.<br></li>
    <li><b>Default mask overlay transparency</b> - Sets the default transparency for newly created masks. Enter a value
        between 0 and 1. 0 means opaque, 1 means transparent.<br></li>
</ul>

<h4><a name="quicklooks">Quicklooks</a></h4>
<img src="images/OptionsDialog-General-7-Quicklooks.png" alt="Quicklooks">

<ul>
    <li><b>Save quicklooks with product where possible</b> - Specify whether SNAP shall save a quicklook with the
        product.<br></li>
    <li><b>Max quicklook width in pixels</b> - Set maximum width of quicklook image.<br></li>
</ul>

<h4><a name="tooladapter">Tool Adapter</a></h4>
<img src="images/OptionsDialog-General-8-ToolAdapter.png" alt="Tool Adapter">

<ul>
    <li><b>Validate tool paths and variables on save</b> - Explanatory text.<br></li>
    <li><b>Display warning when source products are missing</b> - Explanatory text.<br></li>
    <li><b>Display execution output</b> - Explanatory text.<br></li>
    <li><b>Use autocomplete of parameters for template editing [experimental]</b> - Explanatory text.<br></li>
</ul>

<h4><a name="worldview">World View</a></h4>
<img src="images/OptionsDialog-General-9-WorldView.png" alt="World View">

<ul>
    <li><b>Use flat Earth projection</b> - Explanatory text.<br></li>
</ul>

<h4><a name="gpf">GPF</a></h4>
<img src="images/OptionsDialog-General-A-GPF.png" alt="GPF">

<ul>
    <li><b>Beep when processing has finished</b> - Generate a system feedback after processing.<br></li>
</ul>

<h4><a name="remotefilerepos">Remote File Repositories</a></h4>
<img src="images/OptionsDialog-General-B-Remote-File-Repos.png" alt="Remote File Repositories"/>
<p><b>Put content here.</b></p>


<h4><a name="remotefilerepos">Product Library</a></h4>
<img src="images/OptionsDialog-General-C-Product-Library.png" alt="Product Library"/>
<p><b>Put content here.</b></p>


<h4><a name="other">Other</a></h4>
<img src="images/OptionsDialog-General-D-Other.png" alt="Other">

<ul>
    <li><b>Release check interval</b> - Specify when a check for a new SNAP release shall be performed.
        Available options are:
    </li>
</ul>
<img src="images/OptionsDialog-ReleaseCheckInterval.png" alt="Options">


<h3>Layer Settings</h3>

<h4><a name="graticulelayer">Graticule Layer</a></h4>
<img src="images/OptionsDialog-Layer-1-GraticuleLayer.png" alt="Graticule Layer">

<p>This preferences page provides options to customize the <b>Graticule Overlay</b>.</p>

<p>You can find a detailed description <a href="ShowGraticuleOverlay.html">here</a>.</p>

<h4><a name="imagelayer">Image Layer</a></h4>
<img src="images/OptionsDialog-Layer-2-ImageLayer.png" alt="Image Layer">

<ul>
    <li><b>Background colour</b> - Select the background colour of the image view from a pre-defined list or customize
        it.<br></li>
    <li><b>Show image border</b> - Draw a border around the image view.<br></li>
    <li><b>Image border size</b> - Specify the image border size in pixels.<br></li>
    <li><b>Image border colour</b> - Select a colour from a pre-defined list or customize it.<br></li>
    <li><b>Show pixel borders in magnified views</b> - Draw a border around pixels when zoomed in.<br></li>
    <li><b>Pixel border size</b> - Specify the pixel border size in pixels.<br></li>
    <li><b>Pixel border colour</b> - Select a colour from a pre-defined list or customize it.<br></li>
</ul>


<h4><a name="nodatalayer">No-Data Layer</a></h4>
<img src="images/OptionsDialog-Layer-3-No-DataLayer.png" alt="No-Data Layer">
<p>This preferences page provides options to customize the <a href="NoDataOverlay.html">No-Data Overlay</a>.</p>
<ul>
    <li><b>No-data overlay colour</b> - Sets the fill colour of the <a href="NoDataOverlay.html">No-Data Overlay</a>.
        Select the no-data overlay colour from a pre-defined list or customize it.<br></li>
    <li><b>No-data overlay transparency</b> - Sets the transparency of the <a href="NoDataOverlay.html">No-Data
        Overlay</a>. Enter a value between 0 and 1. 0 means opaque, 1 means transparent.<br></li>
</ul>

<h4><a name="worldmaplayer">World Map Layer</a></h4>
<img src="images/OptionsDialog-Layer-4-WorldMapLayer.png" alt="World Map Layer">

<ul>
    <li><b>World Map Layer</b> - Select the layer type from a list. Available options:</li>
</ul>
<img src="images/OptionsDialog-WorldMapLayers.png" alt="Options">


<h3>Performance Settings</h3>

<!--<p>&nbsp;</p>-->
<img src="images/OptionsDialog-Performance-1.png" alt="Performance Settings">
<p>This preferences page contains settings for the Java VM and processing parameters.
    Both settings might be computed by SNAP or being reset to default values.</p>
<ul>
    <li><b>VM Parameters</b> - Please refer to
        <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
            <param name="content" value="https://www.oracle.com/technetwork/java/javase/tech/vmoptions-jsp-140102.html">
            <param name="text" value="Java HotSpot VM Options">
        </object>
        .<br>
    </li>
    <li><b>Cache path</b> - Path to the SNAP cache directory.<br></li>
    <li><b>Cache Size (MB)</b> - Maximum size of the SNAP cache directory.<br><br></li>

    <li><b>Tile size (px)</b> - Explanatory text.<br></li>
    <li><b>Number of Threads</b> - Explanatory text.<br></li>
    <li><b>Benchmark operator</b> - Explanatory text.<br></li>
</ul>


<h3><a name="www">WWW Settings</a></h3>
<img src="images/OptionsDialog-WWW-1-Overview.png" alt="WWW">

<ul>
    <li><b>Web Browser</b> - Select your preferred web browser for displaying content.
        Choose between either the system default or a specific browser app. <br></li>
    <li><b>Proxy settings</b> - Specify your proxy settings if needed..<br></li>
    <ul>
        <li><b>No Proxy</b> - Disable proxies</li>
        <li><b>Use System Proxy Settings</b> - Reload proxy settings defined in your system configuration.</li>
        <li><b>Manual Proxy Settings</b> - Enter manual proxy settings.
            Clicking on <a href="#advancedproxy"><img src="images/icons/More....png"></a>
            brings up the <a href="#advancedproxy">Advanced Proxy Settings</a> dialog below.
        </li>
    </ul>
    <li><b>Test connection</b> - Checks whether the proxy settings are valid.</li>
</ul>

<h4><a name="advancedproxy">Advanced Proxy Settings</a></h4>
<img src="images/OptionsDialog-WWW-2-AdvancedProxySettings.png" alt="Advanced Proxy Settings">
<p>If you are behind a proxy you should configure your settings here.<br>
    You are able to configure the settings for different protocols or <u>check the box to use the same settings for all
        protocols.</u></p>
<ul>
    <li><b>HTTP Proxy</b> - Enter the HTTP proxy server address and the port.
    </li>
    <li><b>HTTPS Proxy</b> - Enter the HTTPS proxy server address and the port.
    </li>
    <li><b>SOCKS Proxy</b> - Enter the SOCKS proxy server address and the port.
    </li>
    <li><b>Use HTTP proxy authentication</b><br>
        If your proxy requires authentication enable this option.
    </li>
    <li><b>User name:</b><br>
        Your user name.
    </li>
    <li><b>Password:</b><br>
        Your password.
    </li>

</ul>


<h3><a name="keymap">Keymap Settings</a></h3>
<img src="images/OptionsDialog-Keymap-1.png" alt="Keymap">
<p>In this preference page you are able to change or create keystrokes for actions within SNAP. Keymap settings can be
    edited, stored and managed with this dialog.</p>

<h3><a name="appearance">Appearance Settings</a></h3>
<img src="images/OptionsDialog-Appearance-1-DocumentTabs.png" alt="Appearance">

<ul>
    <li><b>New document opens next to active document tab</b> - New tabs are arranged next to the active tab.<br></li>
    <li><b>Close activates most recent document</b> - When a document is closed then the most recent document becomes
        active instead of its neighbor.<br></li>
    <li><b>Tab placement</b> - Define where tabs are displayed: at top, left, bottom or right of the image view.<br></li>
    <li><b>Multi-row tabs</b> - Specify whether tabs shall be displayed in more than one row.<br>
        <ul>
            <li><b>Maximum row count</b> - Specify the number of rows allowed, e.g. 3. See <a
                    href="#multirowtabs">image</a> below.
            </li>
        </ul>
    <li><b>Show parent folder name in tab title</b> - Display parent folder name in tab.<br></li>
    <li><b>Show full file path</b> - Specify the full path in tab.<br></li>
</ul>
<a name="multirowtabs"></a> <img src="images/OptionsDialog-Appearance-1a-Multi-row-tabs.png" alt="Multi-row tabs">


<h4><a name="windows">Windows</a></h4>
<img src="images/OptionsDialog-Appearance-2-Windows.png" alt="No-Data Layer">

<ul>
    <li><b>Drag window image</b> - Enables "ghost" window image during drag and drop of a window.<br></li>
    <li><b>Transparent drag window image</b> - Enables transparency in drag window image.<br></li>
    <li><b>Snapping floating windows</b> - Enables automatic snapping of floating windows for easier layout handling.<br></li>
    <li><b>Snap to screen edges</b> - Enables snapping of floating windows to screen edges.<br></li>
    <li><b>Transparent floating windows</b> - Makes unfocused floating windows semi-transparent after a few seconds.<br></li>
</ul>


<h4><a name="lookandfeel">Look and Feel</a></h4>
<img src="images/OptionsDialog-Appearance-3-LookAndFeel.png" alt="Look and Feel">

<ul>
    <li><b>Preferred look and feel</b> - Select your favourite look-and-feel from a list. Note that the activation requires a restart of SNAP.<br></li>
    <li><b>Maximize use of native look and feel</b> - NetBeans uses native UI components when those offer sufficient functionality.
        Select this option to force the use of native components, even when that may limit functionality (e.g. macOS file chooser).<br></li>
</ul>

<hr>
</body>
</html>